POST Refresh Live Video Status
Overview
The table below provides key details about the POST method to refresh the status of a live video.
| Refresh Live Video Status | |
|---|---|
| Method | POST |
| URL or Endpoint | /api/v1/projectId/live-hubs/videoId/refresh-status |
| Headers | Authorization |
| Content Type | application/json |
| Parameters | projectId, videoId |
| Request Body | None |
The description of the URL parameters is as follows:
| videoId URL Parameter | |
|---|---|
| URL Parameter Name | videoId |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the live video. |
| projectId URL Parameter | |
|---|---|
| URL Parameter Name | projectId |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the project. |
Request Body
No body parameters are required for the "Refresh Live Video Status" endpoint.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"statusName": "string",
"healthStatusName": "string"
},
"resultInfo": null,
"statusCode": 200
}
Response Fields
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful, it will return true. Otherwise, it will return false. |
| errors | array[] | Indicates if there were any errors during the request. |
| messages | array[] | Returns any messages from the back-end system. |
| result | object | Contains the live video status and health information. |
| statusName | string | The current status of the live video (e.g., "Live"). |
| healthStatusName | string | The health status of the live video (e.g., "Healthy"). |
| resultInfo | string | Provides additional information about the result. |
| statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code 400: Bad Request
- HTTP Status Code 401: Unauthorized
- HTTP Status Code 403: Forbidden
- HTTP Status Code 404: Result Not Found
- HTTP Status Code 500: Internal Server Error
- HTTP Status Code 503: Backend Fetch Failed